Structured Headings
Domain Message Specification

Version: 1.0; Status: RC3

HealthCareFacilityUniversal Tabular View

COCD_TP145211GB01
HealthCareFacility

A template to identify the health care facility where the encompassing encounter took place, or with which the encompassing encounter is associated.

This class carries the health care facility details
Used by:
[1..1] [M] classCode (CS { CNE: RoleClass } )
{ Fixed="SDLOC" }

Model Attribute Description

The HL7 attribute classCode describes this class as a service delivery location.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "SDLOC".
[1..1] [M] code (CV { CNE:CDACareSettingTypeSnCT } )
Model Attribute Description

The HL7 attribute code uses a code from the CDACareSettingTypeSnCT vocabulary to describe the type of service delivery location.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the code from theCDACareSettingTypeSnCT vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the code in the CDACareSettingTypeSnCTvocabulary.
[0..*] id (SET<II>)

Model Attribute Description

The HL7 attribute id uses one or more identifier(s) including local identifiers to identify the service delivery location.

Implementation in XML Instance

When the local identifier scheme can be identified using an OID then the XML element id shall carry the identifiers as follows:
  • The XML attribute root shall contain the OID for the identifying system.
  • The XML attribute extension shall contain the identifier.

When using alternative identifiers where the identifier scheme can not be identified using an OID then the XML element id shall carry the identifiers as follows:

  • The XML attribute root shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.38".
  • The XML attribute extension shall contain the identifier.
  • The XML attribute assigningAuthorityName shall contain the assigning organisation in the format of ODSCode:ODSName, for example:
assigningAuthorityName="RA9:SOUTH DEVON HEALTHCARE NHS TRUST"
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145211GB01#HealthCareFacility" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP145211GB01#HealthCareFacility"
[0..1] location (Place)
A link to the place.
[0..1] serviceProviderOrganization (Organization)
A link to the organisation which is responsible for the service delivery location.
Place

Details of the actual place which is the location.

Note when this class is used at least one of either name or addr attributes shall be used.

This class should only be used to further define the service delivery location when required and is normally used to identify places which are temporary service deliver places such as the site of a road traffic accident.

Used by: HealthCareFacility
[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="PLC" }

Model Attribute Description

The HL7 attribute classCode describes this class as a place

Implementation in XML Instance

  • The XML attribute classCode is fixed to "PLC".
[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of a place.

Implementation in XML Instance

  • The XML attribute determinerCode is fixed to "INSTANCE".
[1..1] [R] addr (AD)

Model Attribute Description

The HL7 attribute uses an address for the place.

The HL7 attribute addr allows structured and unstructured addresses to be carried. Only a structured address is recommended to be used.

Implementation in XML Instance

There are a number of forms of structured address. The three shown here are the recommended formats for this address; they are listed in no particular order.

The XML element addr is populated as follows:

When using the structured address in the style of PDS the XML element addr shall contain five XML elements streetAddressLine.

  • The first XML element streetAddressLine shall contain the premises name
  • The second XML element streetAddressLine shall contain the number and thoroughfare
  • The third XML element streetAddressLine shall contain the locality
  • The fourth XML element streetAddressLine shall contain the post town
  • The fifth XML element streetAddressLine shall contain the county

The first XML element streetAddressLine or the second XML element streetAddressLine and the fourth XML element streetAddressLine are mandatory to be populated.

  • The XML element postalCode can be used to carry a postcode
  • The XML element addressKey can be used to carry a PAF key

When using the fully structured address format then the XML element addr shall be populated as follows:

  • The XML element houseNumber shall contain the house/building number or name
  • The XML element streetName shall contain the street name
  • The XML element city shall contain the city name
  • The XML element county shall contain the county
  • The XML element country shall contain the country name
  • The XML element postalCode shall contain the postcode
  • The XML element addressKey shall contain the address key

Note that unpopulated XML elements should not be present.

Alternatively the structured address may contain just a series of XML elements streetAddressLine populated in the correct order to render as a postal address with as much information as available included.

  • The first XML element streetAddressLine shall contain the first address line
  • The second XML element streetAddressLine shall contain the second address line
  • The third XML element streetAddressLine shall contain the third address line
  • and so on ....

Note that unpopulated XML elements should not be present.

The XML element addr also allows an XML attribute use and this should be used to further define the address type when required. Only the use values listed below are recommended to be used for this address.

Code
Definition
WP Work place - An office address. First choice for business related contacts during business hours.
TMP Temporary address - A temporary address; may be good for visit or mailing.
PHYS Physical visit address - Used primarily to visit an address.
H
 Home address - The person's home address; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available.
HP
 The primary home address - An address to reach a person after business hours.
HV
 A vacation home - An address to reach a person while on vacation.

When the XML attribute use of the XML element addr contains the value "PHYS" then the following two XML elements of the XML element addr may be populated.

  • The XML element desc of the XML element addr may contain a description of the address; this may be used for things like directions for the address.
  • The XML element additionalLocator of the XML element addr may contain additional location information such as longitude and latitude coordinates.
[1..1] [R] name (TN)

Model Attribute Description

The HL7 attribute name is used when the place has a name.

Implementation in XML Instance

The XML element name shall contain a string which is the name of the place

When the name is not available, then the XML attribute nullFlavor of the XML element name should carry the value "NI"

When the XML element addr is used instead because the place has an address; then the XML attribute nullFlavor of the XML element name should carry the value "NA"
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145211GB01#location" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP145211GB01#location"
Organization

This class details the organisation which scopes the service delivery location (the organisation which owns or is responsible for the service delivery location).
Used by: HealthCareFacility
[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="ORG" }

Model Attribute Description

The HL7 attribute classCode describes this class as an organisation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "ORG".
[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of an organisation.

Implementation in XML Instance

  • The XML attribute determinerCode is fixed to "INSTANCE".
[1..1] [M] id (II)

Model Attribute Description

The HL7 attribute id uses an ODS code as an identifier that uniquely identifies the organisation which is responsible for the service delivery location. The ODS code should identify the organisation at either the site level or organisation level. Where possible the organisation should be identified at the site level. ODS codes were formerly known as NACS codes.

Implementation in XML Instance

When ODS site code is used then the XML element id is populated in the following way:

  • The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.2"
  • The XML attribute extension shall contain the ODS site code.

When ODS organisation code is used then the XML element id is populated in the following way:

  • The XML attribute root shall contain an OID with the value "2.16.840.1.113883.2.1.3.2.4.19.1"
  • The XML attribute extension shall contain the ODS organisation code.
[1..1] [M] name (ON)

Model Attribute Description

The HL7 attribute name uses the description of the organisation associated with the ODS code.

Implementation in XML Instance

  • The XML element name will carry the description associated with the ODS code carried in the XML attribute extension of the XML element id.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145211GB01#serviceProviderOrganization" }

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP145211GB01#serviceProviderOrganization".